
//Namespace
package com.katujo.squirrel.annotations;

//Java imports
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;

/**
 * The Squirrel table annotation, used to mark what table a object,
 * should be persisted to.
 * 
 * <br/><br/>
 * Copyright 2010 Katujo LTD<br/>
 * Licensed under the Apache License, Version 2.0<br/>
 * (the "License"); you may not use this file except in compliance with the License. You may<br/>
 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required <br/>
 * by applicable law or agreed to in writing, software distributed under the License is distributed <br/>
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either <br/>
 * express or implied. See the License for the specific language governing permissions and <br/>
 * limitations under the License. <br/>
 * 
 * @author Johan Hertz
 *
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Table
{
	/**
	 * The name of the table to persist the object to.
	 * @return
	 */
	String name();
	
	/**
	 * Prefix to add to column names;
	 * @return
	 */
	String prefix() default "";
	
	/**
	 * Suffix to add to column names.
	 * @return
	 */
	String suffix() default "";
}
